Skip to content

docs: move the Encore guide to the framework guide structure - #6929

Open
philip wants to merge 1 commit into
mainfrom
docs/encore-guide-refresh
Open

philip wants to merge 1 commit into
mainfrom
docs/encore-guide-refresh

Conversation

@philip

@philip philip commented Nov 20, 2026

Copy link
Copy Markdown
Collaborator

This PR moves the Encore guide to the framework guide structure for Encore.ts. It installs the Encore CLI, creates an app, declares a database and a service in code, runs it locally on Encore's own Postgres, then connects a Neon account to Encore Cloud with an API key. From there it deploys to a production environment that uses Neon, or self-hosts with encore build docker, using the pooled host for the app and the direct host for migrations. It adds a new agent prompt.

It also notes that production environments run in your own AWS or Google Cloud account, that staging uses an Encore-managed database, and that preview environments get a Neon branch for each pull request.

The TypeScript code was type-checked against encore.dev, and the CLI behavior was checked against Encore's source. The Encore Cloud and Docker steps follow Encore's current documentation.

This pull request and its description were written by Isaac.

Rewrite the Encore guide around Encore.ts: declare the database in code, run
it locally, connect a Neon account to Encore Cloud, and deploy to a production
environment that uses Neon, or self-host with encore build docker. Add an agent
prompt, and note that preview environments get a Neon branch for each pull
request.

Co-authored-by: Isaac <no-reply@databricks.com>
@vercel

vercel Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
neon-next Ready Ready Preview Nov 20, 2026 11:57pm UTC

Request Review

@github-actions

Copy link
Copy Markdown

Copybook

1 definition changed since origin/main. Review the rendered output below.

Definition Kind Placements Rendered in Tests
website.prompts.encore-prompt prompt — content/docs/guides/encore.md, src/constants/static-md-manifest.js —
website.prompts.encore-prompt
diff --git a/public/prompts/encore-prompt.md b/public/prompts/encore-prompt.md
new file mode 100644
index 000000000..9a3b7f062
--- /dev/null
+++ b/public/prompts/encore-prompt.md
@@ -0,0 +1,12 @@
+Connect my Encore app to Neon.
+
+- Fetch https://neon.com/prompts/agent-setup.md and follow it.
+
+- Look up Encore's docs at https://encore.dev/llms.txt and its agent skills at https://github.com/encoredev/skills
+
+- Fetch Neon's Encore guide and follow it: https://neon.com/docs/guides/encore.md
+- This guide is for Encore.ts. If my app is written in Go, ask me before you continue.
+- Ask me before you pick or create a Neon project.
+- Ask me before you sign in to Encore, deploy (which includes `git push encore`), or create an Encore environment.
+- Ask me to add a Neon API key in the Encore Cloud dashboard (App Settings > Integrations > Neon). Don't ask me for the key, and don't print it.
+- Finish by showing me the Postgres version from the running server. Use the deployed Neon-backed environment or the self-hosted image, not `encore run`, which uses Encore's local Postgres.

This branch was successfully deployed

1 active deployment
Preview – neon-next — b60e0639 Deployed Nov 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant